Skip to main content
PUT
/
v1
/
inventory
/
warehouses
/
{id}
Update Warehouse
curl --request PUT \
  --url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "East Coast 1",
  "is_active": true
}
'
{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
id
integer<int32>
required

The id of the Warehouse.

Required range: x >= 1

Body

application/json

An object conforming to the Warehouse schema to be merged with the existing Warehouse.

A Warehouse represents a physical location from which you can store inventory and perform operations independently of other warehouses.

ā€‹
name
string

The display name for the Warehouse.

Maximum string length: 255
Example:

"East Coast 1"

ā€‹
is_active
boolean

This flag determines if the Warehouse is active and viable for fulfillment.

Example:

true

Response

OK - The operation completed successfully and there is no response body.